runbook.json

{
    "swagger": "2.0",
    "info": {
      "title": "AutomationManagement",
      "version": "2020-01-13-preview",
      "x-ms-code-generation-settings": {
        "useDateTimeOffset": true
      }
    },
    "host": "management.azure.com",
    "schemes": [
      "https"
    ],
    "consumes": [
      "application/json"
    ],
    "produces": [
      "application/json"
    ],
    "security": [
      {
        "azure_auth": [
          "user_impersonation"
        ]
      }
    ],
    "securityDefinitions": {
      "azure_auth": {
        "type": "oauth2",
        "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
        "flow": "implicit",
        "description": "Azure Active Directory OAuth2 Flow",
        "scopes": {
          "user_impersonation": "impersonate your user account"
        }
      }
    },
    "paths": {
      "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/content": {
        "get": {
          "tags": [
            "RunbookDraft"
          ],
          "operationId": "RunbookDraft_GetContent",
          "description": "Retrieve the content of runbook draft identified by runbook name.",
          "externalDocs": {
            "url": "http://aka.ms/azureautomationsdk/runbookdraftoperations"
          },
          "x-ms-examples": {
            "Get runbook draft content": {
              "$ref": "./examples/getRunbookDraftContent.json"
            }
          },
          "produces": [
            "text/powershell"
          ],
          "parameters": [
            {
              "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter"
            },
            {
              "name": "runbookName",
              "in": "path",
              "required": true,
              "type": "string",
              "description": "The runbook name."
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
            }
          ],
          "responses": {
            "200": {
              "description": "OK",
              "schema": {
                "type": "string"
              }
            },
            "default": {
              "description": "Automation error response describing why the operation failed.",
              "schema": {
                "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse"
              }
            }
          }
        },
        "put": {
          "tags": [
            "RunbookDraft"
          ],
          "operationId": "RunbookDraft_ReplaceContent",
          "description": "Replaces the runbook draft content.",
          "externalDocs": {
            "url": "http://aka.ms/azureautomationsdk/runbookdraftoperations"
          },
          "x-ms-examples": {
            "Create or update runbook draft": {
              "$ref": "./examples/replaceRunbookDraftContent.json"
            }
          },
          "consumes": [
            "text/powershell"
          ],
          "parameters": [
            {
              "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter"
            },
            {
              "name": "runbookName",
              "in": "path",
              "required": true,
              "type": "string",
              "description": "The runbook name."
            },
            {
              "name": "runbookContent",
              "in": "body",
              "required": true,
              "schema": {
                "type": "object",
                "format": "file"
              },
              "description": "The runbook draft content."
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
            }
          ],
          "responses": {
            "200": {
              "description": "OK",
              "schema": {
                "type": "string"
              }
            },
            "202": {
              "description": "Accepted and  the operation will complete asynchronously.",
              "headers": {
                "location": {
                  "description": "URL to query for status of the operation.",
                  "type": "string"
                }
              }
            },
            "default": {
              "description": "Automation error response describing why the operation failed.",
              "schema": {
                "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse"
              }
            }
          },
          "x-ms-long-running-operation": true,
          "x-ms-long-running-operation-options": {
            "final-state-via": "location"
          }
        }
      },
      "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft": {
        "get": {
          "tags": [
            "RunbookDraft"
          ],
          "operationId": "RunbookDraft_Get",
          "description": "Retrieve the runbook draft identified by runbook name.",
          "externalDocs": {
            "url": "http://aka.ms/azureautomationsdk/runbookdraftoperations"
          },
          "x-ms-examples": {
            "Get runbook draft": {
              "$ref": "./examples/getRunbookDraft.json"
            }
          },
          "parameters": [
            {
              "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter"
            },
            {
              "name": "runbookName",
              "in": "path",
              "required": true,
              "type": "string",
              "description": "The runbook name."
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
            }
          ],
          "responses": {
            "200": {
              "description": "OK",
              "schema": {
                "$ref": "#/definitions/RunbookDraft"
              }
            },
            "default": {
              "description": "Automation error response describing why the operation failed.",
              "schema": {
                "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse"
              }
            }
          }
        }
      },
      "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/publish": {
        "post": {
          "tags": [
            "Runbook"
          ],
          "operationId": "Runbook_Publish",
          "description": "Publish runbook draft.",
          "externalDocs": {
            "url": "http://aka.ms/azureautomationsdk/runbookdraftoperations"
          },
          "x-ms-examples": {
            "Publish runbook draft": {
              "$ref": "./examples/publishRunbook.json"
            }
          },
          "parameters": [
            {
              "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter"
            },
            {
              "name": "runbookName",
              "in": "path",
              "required": true,
              "type": "string",
              "description": "The parameters supplied to the publish runbook operation."
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
            }
          ],
          "responses": {
            "202": {
              "description": "Accepted and  the operation will complete asynchronously.",
              "headers": {
                "location": {
                  "description": "URL to query for status of the operation.",
                  "type": "string"
                }
              }
            },
            "default": {
              "description": "Automation error response describing why the operation failed.",
              "schema": {
                "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse"
              }
            }
          },
          "x-ms-long-running-operation": true
        }
      },
      "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/undoEdit": {
        "post": {
          "tags": [
            "RunbookDraft"
          ],
          "operationId": "RunbookDraft_UndoEdit",
          "description": "Undo draft edit to last known published state identified by runbook name.",
          "externalDocs": {
            "url": "http://aka.ms/azureautomationsdk/runbookdraftoperations"
          },
          "x-ms-examples": {
            "Undo draft edit to last known published state": {
              "$ref": "./examples/undoDraftEditToLastKnownPublishedState.json"
            }
          },
          "parameters": [
            {
              "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter"
            },
            {
              "name": "runbookName",
              "in": "path",
              "required": true,
              "type": "string",
              "description": "The runbook name."
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
            }
          ],
          "responses": {
            "200": {
              "description": "OK"
            },
            "default": {
              "description": "Automation error response describing why the operation failed.",
              "schema": {
                "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse"
              }
            }
          }
        }
      },
      "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/content": {
        "get": {
          "tags": [
            "Runbook"
          ],
          "operationId": "Runbook_GetContent",
          "description": "Retrieve the content of runbook identified by runbook name.",
          "externalDocs": {
            "url": "http://aka.ms/azureautomationsdk/runbookoperations"
          },
          "x-ms-examples": {
            "Get runbook content": {
              "$ref": "./examples/getRunbookContent.json"
            }
          },
          "produces": [
            "text/powershell"
          ],
          "parameters": [
            {
              "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter"
            },
            {
              "name": "runbookName",
              "in": "path",
              "required": true,
              "type": "string",
              "description": "The runbook name."
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
            }
          ],
          "responses": {
            "200": {
              "description": "OK",
              "schema": {
                "type": "string"
              }
            },
            "default": {
              "description": "Automation error response describing why the operation failed.",
              "schema": {
                "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse"
              }
            }
          }
        }
      },
      "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}": {
        "get": {
          "tags": [
            "Runbook"
          ],
          "operationId": "Runbook_Get",
          "description": "Retrieve the runbook identified by runbook name.",
          "externalDocs": {
            "url": "http://aka.ms/azureautomationsdk/runbookoperations"
          },
          "x-ms-examples": {
            "Get runbook": {
              "$ref": "./examples/getRunbook.json"
            }
          },
          "parameters": [
            {
              "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter"
            },
            {
              "name": "runbookName",
              "in": "path",
              "required": true,
              "type": "string",
              "description": "The runbook name."
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
            }
          ],
          "responses": {
            "200": {
              "description": "OK",
              "schema": {
                "$ref": "#/definitions/Runbook"
              }
            },
            "default": {
              "description": "Automation error response describing why the operation failed.",
              "schema": {
                "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse"
              }
            }
          }
        },
        "put": {
          "tags": [
            "Runbook"
          ],
          "operationId": "Runbook_CreateOrUpdate",
          "description": "Create the runbook identified by runbook name.",
          "externalDocs": {
            "url": "http://aka.ms/azureautomationsdk/runbookoperations"
          },
          "x-ms-examples": {
            "Create or update runbook and publish it": {
              "$ref": "./examples/createOrUpdateRunbook.json"
            },
            "Create runbook as draft": {
              "$ref": "./examples/createRunbookAsDraft.json"
            }
          },
          "parameters": [
            {
              "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter"
            },
            {
              "name": "runbookName",
              "in": "path",
              "required": true,
              "type": "string",
              "description": "The runbook name."
            },
            {
              "name": "parameters",
              "in": "body",
              "required": true,
              "schema": {
                "$ref": "#/definitions/RunbookCreateOrUpdateParameters"
              },
              "description": "The create or update parameters for runbook. Provide either content link for a published runbook or draft, not both."
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
            }
          ],
          "responses": {
            "200": {
              "description": "OK",
              "schema": {
                "$ref": "#/definitions/Runbook"
              }
            },
            "201": {
              "description": "Created",
              "schema": {
                "$ref": "#/definitions/Runbook"
              }
            },
            "default": {
              "description": "Automation error response describing why the operation failed.",
              "schema": {
                "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse"
              }
            }
          }
        },
        "patch": {
          "tags": [
            "Runbook"
          ],
          "operationId": "Runbook_Update",
          "description": "Update the runbook identified by runbook name.",
          "externalDocs": {
            "url": "http://aka.ms/azureautomationsdk/runbookoperations"
          },
          "x-ms-examples": {
            "Update runbook": {
              "$ref": "./examples/updateRunbook.json"
            }
          },
          "parameters": [
            {
              "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter"
            },
            {
              "name": "runbookName",
              "in": "path",
              "required": true,
              "type": "string",
              "description": "The runbook name."
            },
            {
              "name": "parameters",
              "in": "body",
              "required": true,
              "schema": {
                "$ref": "#/definitions/RunbookUpdateParameters"
              },
              "description": "The update parameters for runbook."
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
            }
          ],
          "responses": {
            "200": {
              "description": "OK",
              "schema": {
                "$ref": "#/definitions/Runbook"
              }
            },
            "default": {
              "description": "Automation error response describing why the operation failed.",
              "schema": {
                "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse"
              }
            }
          }
        },
        "delete": {
          "tags": [
            "Runbook"
          ],
          "operationId": "Runbook_Delete",
          "description": "Delete the runbook by name.",
          "externalDocs": {
            "url": "http://aka.ms/azureautomationsdk/runbookoperations"
          },
          "x-ms-examples": {
            "Delete a runbook": {
              "$ref": "./examples/deleteRunbook.json"
            }
          },
          "parameters": [
            {
              "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter"
            },
            {
              "name": "runbookName",
              "in": "path",
              "required": true,
              "type": "string",
              "description": "The runbook name."
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
            }
          ],
          "responses": {
            "200": {
              "description": "OK"
            },
            "204": {
              "description": "No Content"
            },
            "default": {
              "description": "Automation error response describing why the operation failed.",
              "schema": {
                "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse"
              }
            }
          }
        }
      },
      "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks": {
        "get": {
          "tags": [
            "Runbook"
          ],
          "operationId": "Runbook_ListByAutomationAccount",
          "description": "Retrieve a list of runbooks.",
          "externalDocs": {
            "url": "http://aka.ms/azureautomationsdk/runbookoperations"
          },
          "x-ms-examples": {
            "List runbooks by automation account": {
              "$ref": "./examples/listRunbooksByAutomationAccount.json"
            }
          },
          "parameters": [
            {
              "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
            }
          ],
          "responses": {
            "200": {
              "description": "OK",
              "schema": {
                "$ref": "#/definitions/RunbookListResult"
              }
            },
            "default": {
              "description": "Automation error response describing why the operation failed.",
              "schema": {
                "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse"
              }
            }
          },
          "x-ms-pageable": {
            "nextLinkName": "nextLink"
          }
        }
      },
      "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/streams/{jobStreamId}": {
        "get": {
          "tags": [
            "TestJobStream"
          ],
          "operationId": "TestJobStreams_Get",
          "description": "Retrieve a test job stream of the test job identified by runbook name and stream id.",
          "externalDocs": {
            "url": "http://aka.ms/azureautomationsdk/jobstreamoperations"
          },
          "x-ms-examples": {
            "Get test job stream": {
              "$ref": "./examples/getTestJobStream.json"
            }
          },
          "parameters": [
            {
              "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter"
            },
            {
              "name": "runbookName",
              "in": "path",
              "required": true,
              "type": "string",
              "description": "The runbook name."
            },
            {
              "name": "jobStreamId",
              "in": "path",
              "required": true,
              "type": "string",
              "description": "The job stream id."
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
            }
          ],
          "responses": {
            "200": {
              "description": "OK",
              "schema": {
                "$ref": "#/definitions/JobStream"
              }
            },
            "default": {
              "description": "Automation error response describing why the operation failed.",
              "schema": {
                "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse"
              }
            }
          }
        }
      },
      "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/streams": {
        "get": {
          "tags": [
            "TestJobStream"
          ],
          "operationId": "TestJobStreams_ListByTestJob",
          "description": "Retrieve a list of test job streams identified by runbook name.",
          "externalDocs": {
            "url": "http://aka.ms/azureautomationsdk/jobstreamoperations"
          },
          "x-ms-examples": {
            "List job streams by job name": {
              "$ref": "./examples/listTestJobStreamsByJob.json"
            }
          },
          "parameters": [
            {
              "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter"
            },
            {
              "name": "runbookName",
              "in": "path",
              "required": true,
              "type": "string",
              "description": "The runbook name."
            },
            {
              "name": "$filter",
              "in": "query",
              "required": false,
              "type": "string",
              "description": "The filter to apply on the operation."
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
            }
          ],
          "responses": {
            "200": {
              "description": "OK",
              "schema": {
                "$ref": "#/definitions/JobStreamListResult"
              }
            },
            "default": {
              "description": "Automation error response describing why the operation failed.",
              "schema": {
                "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse"
              }
            }
          },
          "x-ms-pageable": {
            "nextLinkName": "nextLink"
          }
        }
      },
      "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob": {
        "put": {
          "tags": [
            "TestJob"
          ],
          "operationId": "TestJob_Create",
          "description": "Create a test job of the runbook.",
          "externalDocs": {
            "url": "http://aka.ms/azureautomationsdk/testjoboperations"
          },
          "x-ms-examples": {
            "Create test job": {
              "$ref": "./examples/createTestJob.json"
            }
          },
          "parameters": [
            {
              "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter"
            },
            {
              "name": "runbookName",
              "in": "path",
              "required": true,
              "type": "string",
              "description": "The parameters supplied to the create test job operation."
            },
            {
              "name": "parameters",
              "in": "body",
              "required": true,
              "schema": {
                "$ref": "#/definitions/TestJobCreateParameters"
              },
              "description": "The parameters supplied to the create test job operation."
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
            }
          ],
          "responses": {
            "201": {
              "description": "Created",
              "schema": {
                "$ref": "#/definitions/TestJob"
              }
            },
            "default": {
              "description": "Automation error response describing why the operation failed.",
              "schema": {
                "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse"
              }
            }
          }
        },
        "get": {
          "tags": [
            "TestJob"
          ],
          "operationId": "TestJob_Get",
          "description": "Retrieve the test job for the specified runbook.",
          "externalDocs": {
            "url": "http://aka.ms/azureautomationsdk/testjoboperations"
          },
          "x-ms-examples": {
            "Get test job": {
              "$ref": "./examples/getTestJob.json"
            }
          },
          "parameters": [
            {
              "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter"
            },
            {
              "name": "runbookName",
              "in": "path",
              "required": true,
              "type": "string",
              "description": "The runbook name."
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
            }
          ],
          "responses": {
            "200": {
              "description": "OK",
              "schema": {
                "$ref": "#/definitions/TestJob"
              }
            },
            "default": {
              "description": "Automation error response describing why the operation failed.",
              "schema": {
                "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse"
              }
            }
          }
        }
      },
      "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/resume": {
        "post": {
          "tags": [
            "TestJob"
          ],
          "operationId": "TestJob_Resume",
          "description": "Resume the test job.",
          "externalDocs": {
            "url": "http://aka.ms/azureautomationsdk/testjoboperations"
          },
          "x-ms-examples": {
            "Resume test job": {
              "$ref": "./examples/resumeTestJob.json"
            }
          },
          "parameters": [
            {
              "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter"
            },
            {
              "name": "runbookName",
              "in": "path",
              "required": true,
              "type": "string",
              "description": "The runbook name."
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
            }
          ],
          "responses": {
            "200": {
              "description": "OK"
            },
            "default": {
              "description": "Automation error response describing why the operation failed.",
              "schema": {
                "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse"
              }
            }
          }
        }
      },
      "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/stop": {
        "post": {
          "tags": [
            "TestJob"
          ],
          "operationId": "TestJob_Stop",
          "description": "Stop the test job.",
          "externalDocs": {
            "url": "http://aka.ms/azureautomationsdk/testjoboperations"
          },
          "x-ms-examples": {
            "Stop test job": {
              "$ref": "./examples/stopTestJob.json"
            }
          },
          "parameters": [
            {
              "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter"
            },
            {
              "name": "runbookName",
              "in": "path",
              "required": true,
              "type": "string",
              "description": "The runbook name."
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
            }
          ],
          "responses": {
            "200": {
              "description": "OK"
            },
            "default": {
              "description": "Automation error response describing why the operation failed.",
              "schema": {
                "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse"
              }
            }
          }
        }
      },
      "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/suspend": {
        "post": {
          "tags": [
            "TestJob"
          ],
          "operationId": "TestJob_Suspend",
          "description": "Suspend the test job.",
          "externalDocs": {
            "url": "http://aka.ms/azureautomationsdk/testjoboperations"
          },
          "x-ms-examples": {
            "Suspend test job": {
              "$ref": "./examples/suspendTestJob.json"
            }
          },
          "parameters": [
            {
              "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter"
            },
            {
              "name": "runbookName",
              "in": "path",
              "required": true,
              "type": "string",
              "description": "The runbook name."
            },
            {
              "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
            }
          ],
          "responses": {
            "200": {
              "description": "OK"
            },
            "default": {
              "description": "Automation error response describing why the operation failed.",
              "schema": {
                "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse"
              }
            }
          }
        }
      }
    },
    "definitions": {
      "JobStream": {
        "properties": {
          "id": {
            "type": "string",
            "description": "Gets or sets the id of the resource."
          },
          "properties": {
            "$ref": "#/definitions/JobStreamProperties",
            "x-ms-client-flatten": true,
            "description": "Gets or sets the id of the job stream."
          }
        },
        "description": "Definition of the job stream."
      },
      "JobStreamProperties": {
        "properties": {
          "jobStreamId": {
            "type": "string",
            "description": "Gets or sets the id of the job stream."
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Gets or sets the creation time of the job.",
            "x-nullable": false
          },
          "streamType": {
            "type": "string",
            "description": "Gets or sets the stream type.",
            "enum": [
              "Progress",
              "Output",
              "Warning",
              "Error",
              "Debug",
              "Verbose",
              "Any"
            ],
            "x-ms-enum": {
              "name": "JobStreamType",
              "modelAsString": true
            }
          },
          "streamText": {
            "type": "string",
            "description": "Gets or sets the stream text."
          },
          "summary": {
            "type": "string",
            "description": "Gets or sets the summary."
          },
          "value": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            },
            "description": "Gets or sets the values of the job stream."
          }
        },
        "x-ms-client-flatten": true,
        "description": "Definition of the job stream."
      },
      "JobStreamListResult": {
        "properties": {
          "value": {
            "type": "array",
            "items": {
              "$ref": "#/definitions/JobStream"
            },
            "description": "A list of job streams."
          },
          "nextLink": {
            "type": "string",
            "description": "Gets or sets the next link."
          }
        },
        "description": "The response model for the list job stream operation."
      },
      "ContentHash": {
        "properties": {
          "algorithm": {
            "type": "string",
            "description": "Gets or sets the content hash algorithm used to hash the content."
          },
          "value": {
            "type": "string",
            "description": "Gets or sets expected hash value of the content."
          }
        },
        "required": [
          "algorithm",
          "value"
        ],
        "description": "Definition of the runbook property type."
      },
      "ContentLink": {
        "properties": {
          "uri": {
            "type": "string",
            "description": "Gets or sets the uri of the runbook content."
          },
          "contentHash": {
            "$ref": "#/definitions/ContentHash",
            "description": "Gets or sets the hash."
          },
          "version": {
            "type": "string",
            "description": "Gets or sets the version of the content."
          }
        },
        "description": "Definition of the content link."
      },
      "RunbookProperties": {
        "properties": {
          "runbookType": {
            "type": "string",
            "description": "Gets or sets the type of the runbook.",
            "enum": [
              "Script",
              "Graph",
              "PowerShellWorkflow",
              "PowerShell",
              "GraphPowerShellWorkflow",
              "GraphPowerShell"
            ],
            "x-ms-enum": {
              "name": "RunbookTypeEnum",
              "modelAsString": true
            }
          },
          "publishContentLink": {
            "$ref": "#/definitions/ContentLink",
            "description": "Gets or sets the published runbook content link."
          },
          "state": {
            "type": "string",
            "description": "Gets or sets the state of the runbook.",
            "enum": [
              "New",
              "Edit",
              "Published"
            ],
            "x-ms-enum": {
              "name": "RunbookState",
              "modelAsString": true
            }
          },
          "logVerbose": {
            "type": "boolean",
            "description": "Gets or sets verbose log option."
          },
          "logProgress": {
            "type": "boolean",
            "description": "Gets or sets progress log option."
          },
          "logActivityTrace": {
            "type": "integer",
            "format": "int32",
            "description": "Gets or sets the option to log activity trace of the runbook."
          },
          "jobCount": {
            "type": "integer",
            "format": "int32",
            "description": "Gets or sets the job count of the runbook."
          },
          "parameters": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/definitions/RunbookParameter"
            },
            "description": "Gets or sets the runbook parameters."
          },
          "outputTypes": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Gets or sets the runbook output types."
          },
          "draft": {
            "$ref": "#/definitions/RunbookDraft",
            "description": "Gets or sets the draft runbook properties."
          },
          "provisioningState": {
            "type": "string",
            "description": "Gets or sets the provisioning state of the runbook.",
            "enum": [
              "Succeeded"
            ],
            "x-ms-enum": {
              "name": "RunbookProvisioningState",
              "modelAsString": false
            }
          },
          "lastModifiedBy": {
            "type": "string",
            "description": "Gets or sets the last modified by."
          },
          "creationTime": {
            "type": "string",
            "format": "date-time",
            "description": "Gets or sets the creation time.",
            "x-nullable": false
          },
          "lastModifiedTime": {
            "type": "string",
            "format": "date-time",
            "description": "Gets or sets the last modified time.",
            "x-nullable": false
          },
          "description": {
            "type": "string",
            "description": "Gets or sets the description."
          }
        },
        "description": "Definition of the runbook property type."
      },
      "Runbook": {
        "properties": {
          "properties": {
            "$ref": "#/definitions/RunbookProperties",
            "x-ms-client-flatten": true,
            "description": "Gets or sets the runbook properties."
          },
          "etag": {
            "type": "string",
            "description": "Gets or sets the etag of the resource."
          }
        },
        "allOf": [
          {
            "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource"
          }
        ],
        "description": "Definition of the runbook type."
      },
      "RunbookListResult": {
        "properties": {
          "value": {
            "type": "array",
            "items": {
              "$ref": "#/definitions/Runbook"
            },
            "description": "Gets or sets a list of runbooks."
          },
          "nextLink": {
            "type": "string",
            "description": "Gets or sets the next link."
          }
        },
        "description": "The response model for the list runbook operation."
      },
      "RunbookCreateOrUpdateProperties": {
        "properties": {
          "logVerbose": {
            "type": "boolean",
            "description": "Gets or sets verbose log option."
          },
          "logProgress": {
            "type": "boolean",
            "description": "Gets or sets progress log option."
          },
          "runbookType": {
            "type": "string",
            "description": "Gets or sets the type of the runbook.",
            "enum": [
              "Script",
              "Graph",
              "PowerShellWorkflow",
              "PowerShell",
              "GraphPowerShellWorkflow",
              "GraphPowerShell"
            ],
            "x-ms-enum": {
              "name": "RunbookTypeEnum",
              "modelAsString": true
            }
          },
          "draft": {
            "$ref": "#/definitions/RunbookDraft",
            "description": "Gets or sets the draft runbook properties."
          },
          "publishContentLink": {
            "$ref": "#/definitions/ContentLink",
            "description": "Gets or sets the published runbook content link."
          },
          "description": {
            "type": "string",
            "description": "Gets or sets the description of the runbook."
          },
          "logActivityTrace": {
            "type": "integer",
            "format": "int32",
            "description": "Gets or sets the activity-level tracing options of the runbook."
          }
        },
        "required": [
          "runbookType"
        ],
        "description": "The parameters supplied to the create or update runbook properties."
      },
      "RunbookCreateOrUpdateParameters": {
        "properties": {
          "properties": {
            "$ref": "#/definitions/RunbookCreateOrUpdateProperties",
            "x-ms-client-flatten": true,
            "description": "Gets or sets runbook create or update properties."
          },
          "name": {
            "type": "string",
            "description": "Gets or sets the name of the resource."
          },
          "location": {
            "type": "string",
            "description": "Gets or sets the location of the resource."
          },
          "tags": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Gets or sets the tags attached to the resource."
          }
        },
        "required": [
          "properties"
        ],
        "description": "The parameters supplied to the create or update runbook operation."
      },
      "RunbookUpdateProperties": {
        "properties": {
          "description": {
            "type": "string",
            "description": "Gets or sets the description of the runbook."
          },
          "logVerbose": {
            "type": "boolean",
            "description": "Gets or sets verbose log option."
          },
          "logProgress": {
            "type": "boolean",
            "description": "Gets or sets progress log option."
          },
          "logActivityTrace": {
            "type": "integer",
            "format": "int32",
            "description": "Gets or sets the activity-level tracing options of the runbook."
          }
        },
        "description": "The parameters supplied to the update runbook properties."
      },
      "RunbookUpdateParameters": {
        "properties": {
          "properties": {
            "$ref": "#/definitions/RunbookUpdateProperties",
            "x-ms-client-flatten": true,
            "description": "Gets or sets the runbook update properties."
          },
          "name": {
            "type": "string",
            "description": "Gets or sets the name of the resource."
          },
          "location": {
            "type": "string",
            "description": "Gets or sets the location of the resource."
          },
          "tags": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Gets or sets the tags attached to the resource."
          }
        },
        "description": "The parameters supplied to the update runbook operation."
      },
      "RunbookDraftUndoEditResult": {
        "properties": {
          "statusCode": {
            "type": "string",
            "enum": [
              "Continue",
              "SwitchingProtocols",
              "OK",
              "Created",
              "Accepted",
              "NonAuthoritativeInformation",
              "NoContent",
              "ResetContent",
              "PartialContent",
              "MultipleChoices",
              "Ambiguous",
              "MovedPermanently",
              "Moved",
              "Found",
              "Redirect",
              "SeeOther",
              "RedirectMethod",
              "NotModified",
              "UseProxy",
              "Unused",
              "TemporaryRedirect",
              "RedirectKeepVerb",
              "BadRequest",
              "Unauthorized",
              "PaymentRequired",
              "Forbidden",
              "NotFound",
              "MethodNotAllowed",
              "NotAcceptable",
              "ProxyAuthenticationRequired",
              "RequestTimeout",
              "Conflict",
              "Gone",
              "LengthRequired",
              "PreconditionFailed",
              "RequestEntityTooLarge",
              "RequestUriTooLong",
              "UnsupportedMediaType",
              "RequestedRangeNotSatisfiable",
              "ExpectationFailed",
              "UpgradeRequired",
              "InternalServerError",
              "NotImplemented",
              "BadGateway",
              "ServiceUnavailable",
              "GatewayTimeout",
              "HttpVersionNotSupported"
            ],
            "x-ms-enum": {
              "name": "HttpStatusCode",
              "modelAsString": true
            }
          },
          "requestId": {
            "type": "string"
          }
        },
        "description": "The response model for the undo edit runbook operation."
      },
      "RunbookDraft": {
        "properties": {
          "inEdit": {
            "type": "boolean",
            "description": "Gets or sets whether runbook is in edit mode."
          },
          "draftContentLink": {
            "$ref": "#/definitions/ContentLink",
            "description": "Gets or sets the draft runbook content link."
          },
          "creationTime": {
            "type": "string",
            "format": "date-time",
            "description": "Gets or sets the creation time of the runbook draft.",
            "x-nullable": false
          },
          "lastModifiedTime": {
            "type": "string",
            "format": "date-time",
            "description": "Gets or sets the last modified time of the runbook draft.",
            "x-nullable": false
          },
          "parameters": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/definitions/RunbookParameter"
            },
            "description": "Gets or sets the runbook draft parameters."
          },
          "outputTypes": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Gets or sets the runbook output types."
          }
        }
      },
      "RunbookParameter": {
        "properties": {
          "type": {
            "type": "string",
            "description": "Gets or sets the type of the parameter."
          },
          "isMandatory": {
            "type": "boolean",
            "description": "Gets or sets a Boolean value to indicate whether the parameter is mandatory or not."
          },
          "position": {
            "type": "integer",
            "format": "int32",
            "description": "Get or sets the position of the parameter."
          },
          "defaultValue": {
            "type": "string",
            "description": "Gets or sets the default value of parameter."
          }
        },
        "description": "Definition of the runbook parameter type."
      },
      "TestJobCreateParameters": {
        "properties": {
          "parameters": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Gets or sets the parameters of the test job."
          },
          "runOn": {
            "type": "string",
            "description": "Gets or sets the runOn which specifies the group name where the job is to be executed."
          }
        },
        "description": "The parameters supplied to the create test job operation."
      },
      "TestJob": {
        "x-ms-mutability": [
          "read",
          "create"
        ],
        "properties": {
          "creationTime": {
            "type": "string",
            "format": "date-time",
            "description": "Gets or sets the creation time of the test job.",
            "x-nullable": false
          },
          "status": {
            "type": "string",
            "description": "Gets or sets the status of the test job."
          },
          "statusDetails": {
            "type": "string",
            "description": "Gets or sets the status details of the test job."
          },
          "runOn": {
            "type": "string",
            "description": "Gets or sets the runOn which specifies the group name where the job is to be executed."
          },
          "startTime": {
            "type": "string",
            "format": "date-time",
            "description": "Gets or sets the start time of the test job.",
            "x-nullable": true
          },
          "endTime": {
            "type": "string",
            "format": "date-time",
            "description": "Gets or sets the end time of the test job.",
            "x-nullable": true
          },
          "exception": {
            "type": "string",
            "description": "Gets or sets the exception of the test job."
          },
          "lastModifiedTime": {
            "type": "string",
            "format": "date-time",
            "description": "Gets or sets the last modified time of the test job.",
            "x-nullable": false
          },
          "lastStatusModifiedTime": {
            "type": "string",
            "format": "date-time",
            "description": "Gets or sets the last status modified time of the test job.",
            "x-nullable": true
          },
          "parameters": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Gets or sets the parameters of the test job."
          },
          "logActivityTrace": {
            "type": "integer",
            "format": "int32",
            "description": "The activity-level tracing options of the runbook."
          }
        },
        "description": "Definition of the test job."
      },
      "RunbookCreateOrUpdateDraftProperties": {
        "properties": {
          "logVerbose": {
            "type": "boolean",
            "description": "Gets or sets verbose log option."
          },
          "logProgress": {
            "type": "boolean",
            "description": "Gets or sets progress log option."
          },
          "runbookType": {
            "type": "string",
            "description": "Gets or sets the type of the runbook.",
            "enum": [
              "Script",
              "Graph",
              "PowerShellWorkflow",
              "PowerShell",
              "GraphPowerShellWorkflow",
              "GraphPowerShell"
            ],
            "x-ms-enum": {
              "name": "RunbookTypeEnum",
              "modelAsString": true
            }
          },
          "draft": {
            "$ref": "#/definitions/RunbookDraft",
            "description": "Gets or sets the draft runbook properties."
          },
          "description": {
            "type": "string",
            "description": "Gets or sets the description of the runbook."
          },
          "logActivityTrace": {
            "type": "integer",
            "format": "int32",
            "description": "Gets or sets the activity-level tracing options of the runbook."
          }
        },
        "required": [
          "runbookType",
          "draft"
        ],
        "description": "The parameters supplied to the create or update draft runbook properties."
      },
      "RunbookCreateOrUpdateDraftParameters": {
        "properties": {
          "runbookContent": {
            "type": "string",
            "description": "Content of the Runbook."
          }
        },
        "x-ms-client-flatten": true,
        "required": [
          "runbookContent"
        ],
        "description": "The parameters supplied to the create or update runbook operation."
      }
    },
    "parameters": {}
  }